TextSnapshot.getSelected()

Доступность

Среда разработки: Flash MX 2004.

Плеер: SWF файлы, опубликованные для Flash Player 6 или более поздних версий, проигрываются во Flash Player 7 и более поздних.

Синтаксис

my_snap.getSelected(from:Number, to:Number) : Boolean

Параметры

from Число, отражающее позицию первого символа в тексте объекта my_snap, с которого будет произведена проверка. Корректными значениями для параметра from являются значения от 0 до TextSnapshot.getCount() - 1. Если параметру from присвоено отрицательное значение, используется 0.

to Число, на единицу большее индекса последнего символа в объекте my_snap, который будет проверен. Корректными значениями для to являются значения от 0 до TextSnapshot.getCount(). Символ с индексом, указанным в параметре to, не включается в обрабатываемую строку. Если данный параметр опущен, используете величина, возвращаемая методом TextSnapshot.getCount(). Если значение данного параметра меньше или равно, чем значение параметра from, используется значение from+1.

Возвращает

Булева величина, равная true, если хотя бы один символ в указанном выше промежутке выбран при помощи метода TextSnapshot.setSelected(), в противном случае false.

Описание

Метод; возвращает булеву величину, определяющую, содержит ли объект TextSnapshot выбранные символы в указанном промежутке.

Для проверки всех символов, передайте величину 0 параметру from и TextSnapshot.getCount() (или любое большее число) параметру  to. Для проверки одного символа, передайте значение, равное значению параметра from+1 параметру to.

Пример

Код в нижеследующем примере показывает, как пользоваться данным методом. Перед использованием этого кода, разместите на Сцене статическое текстовое поле с текстом “TextSnapshot Example”.

// В этом примере предполагается, что мувиклип содержит
// статическое текстовое поле с текстом "TextSnapshot Example"
var my_mc:MovieClip = this;
var my_snap:TextSnapshot = my_mc.getTextSnapshot();
var count:Number = my_snap.getCount();
var theText:String = my_snap.getText(0, count, false);
trace(count); // выводит: 20
trace(theText); // выводит: TextSnapshot Example

См. также

TextSnapshot.getSelectedText(), TextSnapshot.getText()